home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / game / patch / TheMod.lha / TheMod / docs / TheMod.txt < prev   
Encoding:
Text File  |  1999-06-22  |  13.6 KB  |  387 lines
  1.    
  2.  
  3. TheMod v0.98 - Quake Competition servermod by 'surgeon'   
  4.  
  5. Date  : 22/6 1999   
  6. Author: christian.michael@groenjord.dk   
  7.  
  8.         http://members.xoom.com/_michael/quake.htm   
  9. ============================================================================= 
  10.  
  11. Main bandwidth saving features:   
  12. (Network traffic is reduced by 46%, compared to standard quake!!)
  13. - wastly reduced amount of tempentities   
  14. - reduced gibs   
  15.  
  16. (network traffic can be further reduced by enabeleing 
  17. antilag)
  18.  
  19. Main FPS boosting features:   
  20. (Framerate is 10-25% higher than standard quake during combat)
  21. - All quakeC based dynamic lightning is disabled   
  22. - Dead bodies and gibs are removed at respawn   
  23. - Explosion effect exchanged for teleporter effect   
  24. - Torches/fire disabled   
  25.  
  26. (framerate can be further improved by disabeling hitflash)
  27.  
  28.  
  29. Some special features:   
  30.  
  31. - Voting system for server administration by the players   
  32. - Map selection: Support for all ID maps + ztndm1-6   
  33. - Prematch practice mode   
  34. - Deathmatch 3 (weapons stay, fast ammo respawn) supported
  35. - Match countdown and simultaneous starts
  36. - Possibility to autokick players trying to join during a match 
  37. - ON/OFF toggle for powerups, traps and comments   
  38. - Toggle for quad/pent light effect (default off)   
  39. - Toggle for weapon kick (individual) 
  40. - Observer cameras   
  41. - Random respawns   
  42. - Forced respawn after 5 seconds   
  43. - Antilag effects filter   
  44.  
  45. - High performance RocketArena mode built in 
  46.   rotatation on 7 extremely fast maps:   
  47.  
  48.          - Rage Arena (from original fasrv12)   
  49.          - ArenaX     (from original fasrv12)   
  50.          - DocRA1-5   (maps by 'surgeon')   
  51.    
  52. ============================================================================= 
  53.  
  54.    
  55. The Mod installation:   
  56.  
  57. extract the archive to your quake-dir.   
  58. contents should be: 
  59.  
  60.  TheMod/   
  61.         PAK0.PAK   
  62.         PAK1.PAK   
  63.         autoexec.cfg  (server settings) 
  64.         anarchy.cfg   (server settings) 
  65.         arena.cfg     (server settings) 
  66.         match.cfg     (server settings) 
  67.         docs/ 
  68.              TheMod.txt (this file) 
  69.              arena.htm  (documentation for RocketArena) 
  70.  
  71.  
  72. PAK0.PAK contains the vital stuff - don't mess with it :) 
  73.  
  74. PAK1.PAK is optional - it contains a the ztndm(x) maps  - if you already
  75. have the ztndm(x) maps in your ID1 dir, there's no need for this.   
  76.  
  77. autoexec.cfg: is loaded when the server is started the first time 
  78.  it contains the "global" settings such as "noexit" and "hostname" 
  79.  
  80. anarchy.cfg: is loaded whenever a level is started in anarchy(ffa) mode 
  81.  it contains the timelimit, the eventual fraglimit for this mode. 
  82.   
  83. arena.cfg: is loaded whenever the server starts a level in arenamode 
  84.  it cotains the fraglimit (the range 7-15 is suitable) and an eventual timelimit.
  85.  
  86. match.cfg: is loaded whenever the server starts a level in one of the
  87.  matchmodes. Again, it contains the eventual fraglimit and a timelimit. 
  88.  
  89.  the timelimit set in this cfg is ignored IF a match is started. 
  90.  
  91. Please note, that the "samelevel" console variable is toggled internally.
  92. It's used for holding information about serversettings across levels.
  93.  
  94.  
  95. !IMPORTANT! 
  96. The Maps ztndm1-6 are needed for anarchy. They should reside in ID1/maps 
  97. availability: http://www.planetquake.com/ztn 
  98.  
  99.  
  100. Launching the server: 
  101.  
  102. Start quake with the parameters:   
  103.  
  104. -listen [#] -game TheMod   
  105. to set up a listen server   
  106.  
  107. or   
  108.  
  109. -dedicated [#] -game TheMod   
  110. to set up a dedicated server   
  111.    
  112.  
  113. Command aliases and 'online-help' is sent to clients when they connect 
  114. to the server.   
  115.  
  116. =============================================================================   
  117.  
  118. Client commands:   
  119.  
  120.  
  121. General: 
  122. ----------------------------------------------------------------------------- 
  123. "i-server" to display online-help commandlist 
  124. "i-mode", to get info on current servermode 
  125. "i-cam", for camera controls list 
  126. "i-match", to cycle through info on match control 
  127. "i-vote", to cycle through info on votingsessions 
  128. "i-arena", for arena impulse reference 
  129. "i-admin", to cycle through admin cmds 
  130. ----------------------------------------------------------------------------- 
  131. "wkick", to toggle weapon kick ON/OFF (individual setting) 
  132. "hitflash" to toggle flashs ON/OFF (individual setting) 
  133. (will improve framerate in critical situations, such as performing lavajumps)
  134. "observe", to enter observer mode 
  135. "vote", in order to initiate a voting session 
  136.  
  137. Voting: 
  138. ----------------------------------------------------------------------------- 
  139. type "vote" to start a 1 minute session. 
  140. Then subject must be set: 
  141. it can be a map, a random levelchange, a toggle or a servermode. 
  142. Then other players type "yes", to vote for suggested subject 
  143. Maps 
  144. ----------------------------------------------------------------------------- 
  145. "random",to suggest random map/vote for random map. 
  146. to suggest a particular map type the mapname. 
  147. (Supports dm1-6,start,end,e1m1-e4m8,ztndm1-6) 
  148.  
  149. Toggles 
  150. ----------------------------------------------------------------------------- 
  151. to toggle powerups, type "powerups". 
  152. to turn off lavaballs & shooters, type "notraps". 
  153. to toggle deathcomments, type "deathcomments". 
  154. to togle powerup effects, type "pfx". 
  155. to toggle effects filter, type "antilag". 
  156.  
  157. Only in matchmode: 
  158. to toggle dm mode3, type "mode3" 
  159.  
  160. Server Modes 
  161. ----------------------------------------------------------------------------- 
  162. type "ffa1" or "ffa3" to set anarchy modes 
  163. -server will then restart 
  164. type "arena" to put server in RocketArena mode 
  165. -server will then restart 
  166. type "match" for individual match mode or 
  167. type "tmatch1" or "tmatch2" to set teamplay match mode 1 or 2 
  168. -SERVER WILL RESTART IN TRAINING MODE! 
  169.  
  170. Other 
  171. ----------------------------------------------------------------------------- 
  172. type "noadmin" to suggest removal of admin(S) 
  173.  
  174. ============================================================================= 
  175.  
  176. Admin Commands 
  177.  
  178. General
  179. ----------------------------------------------------------------------------- 
  180. IN OBSERVEMODE, type "reqadmin" to suggest yourself as admin
  181. (requires players accept)
  182. Alternatively, type "reqadmin" as subject in a votingsession. 
  183. (also requires players accept) 
  184.  
  185. Once you are admin, you may give up admin status by typing "noadmin". 
  186.  
  187. When you have recieved admin-status you can directly issue commands: 
  188.  
  189. Toggles: 
  190. ----------------------------------------------------------------------------- 
  191. "deathcomments" - toggle "player rides x's rocket" ON/OFF 
  192. "powerups" - disable or enable Quad/666/Ring 
  193. "notraps"  - disable lavaballs & spikeshooters 
  194. "pfx"      - toggle the light associated with powerups 
  195. "mode3"    - toggle weapons stay and fast ammo respawn 
  196. "antilag"  - toggle effects filter 
  197.  
  198. sys_ticrate: 
  199. ----------------------------------------------------------------------------- 
  200. "lticrate" to set 10 updates/sec 
  201. "nticrate" to set 20 updates/sec 
  202. "hticrate" to set 50 updates/sec 
  203.  
  204. Match control: 
  205. ----------------------------------------------------------------------------- 
  206. "beginmatch" to start 30 sec countdown immediately 
  207. "endmatch" to end ongoing match immediately 
  208. "lockmatch" to open/close the server for joining 
  209. "allowjoin" to allow/forbid obsevers to join ongoing match 
  210.  
  211. Map selection/mode selection: 
  212. ----------------------------------------------------------------------------- 
  213. type mapname (e.g. "dm2", "e1m2") to set map, followed by 
  214. "execute" to change level 
  215. type modename (e.g "ffa1", "tmatch2", "arena"), followed by 
  216. "execute" to restart server in new mode 
  217.  
  218. ============================================================================= 
  219.  
  220. Observer Commands: 
  221. ----------------------------------------------------------------------------- 
  222.  
  223. Camera Control 
  224. ----------------------------------------------------------------------------- 
  225. "auto", for auto selection 
  226. "player1"-"player16" selects player 
  227. "follow", for force-follow 
  228. "normal", to end force-follow 
  229. "hand", for force-hand 
  230. "nclip", for noclip 
  231. "messages", to toggle messages 
  232. "lock", to lock on target 
  233. "next", for next target 
  234.  
  235. Other 
  236. ----------------------------------------------------------------------------- 
  237. "join", to exit observer mode 
  238. "reqadmin" to suggest yourself as admin 
  239.  
  240. ============================================================================= 
  241.  
  242.  
  243. Match Commands: 
  244. ----------------------------------------------------------------------------- 
  245. THESE COMMANDS ARE ONLY AVAILABLE IN MATCHMODE 
  246.  - "MODE3" REQUIRES VOTE! 
  247. ----------------------------------------------------------------------------- 
  248. To toggle deathmatch 3 rules on/off, type "mode3" 
  249. (mode3 is weapons stay & 15 sec ammo respawn, compared to normal 30 sec 
  250. ----------------------------------------------------------------------------- 
  251. "ready" to commit to match 
  252. "notready" to uncommit 
  253. when all players have committed, match will start in T-30 seconds 
  254. ----------------------------------------------------------------------------- 
  255. TO ABORT MATCH: disconnect or vote, or ask admin to issue command "endmatch" 
  256.  
  257. ============================================================================= 
  258.  
  259. RocketArena Commands: 
  260. ----------------------------------------------------------------------------- 
  261. "impulse 68" - see stats for current level 
  262. "impulse 69" - see how many are ahead of you 
  263. "impulse 70" - step out of line/back to line 
  264. "impulse 71" - set status bar text for 320x200  
  265. "impulse 72" - set status bar text for 320x240 or higher 
  266.  
  267. =============================================================================  
  268.  
  269. Some notes:   
  270. ------------   
  271. After a votingsession is initiated, subject must be set.   
  272. It can be a mapname (dmX, eXmY, ztndmX, random)   
  273. a toggle (pfx, powerups, traps, deathcomments, mode3, antilag)   
  274. or a matchmode: arena, match, tmatch1, tmatch2, ffa1 or ffa3  
  275. If more than 50% votes "yes" within 1 minute, 
  276. the suggested  change will take effect. 
  277.  
  278. If less than 50% votes yes within 1 minute, the voting session   
  279. will be canceled.   
  280.  
  281. Subject can not be changed during a session.   
  282.  
  283. In the traditional competition modes (team1/2 & individual),
  284. type ready to commit to the match and notready to uncommit.
  285. When all players are ready, a timer will count down from 30 
  286. and spawn all players simultaneously. 
  287.  
  288. Team matches end after 20 minutes. Individual after 10 mins.    
  289. During matches, normal fraglimit and timelimit is ignored!
  290. If a player connects during a match, he will be put in
  291. observermode, and will not be able to join, unless administrator
  292. toggles the "allowjoin" variable.
  293.  
  294. If you connect to a server running TheMod with the name   
  295. camclient or "", you will be put in observermode by default. 
  296. The Prematch training mode is great for practicing lavajumps and rocketjumps 
  297.  
  298.  
  299. Notes on anitlag toggle: 
  300. ------------------------ 
  301. Antilag filters out some effects. 
  302. When antilag is enabled, nail and shaft filters are activated. 
  303. Furthermore gunshots, that doesn't hit anything that takes damage, 
  304. are not displayed. 
  305. Blood is replaced with a tempentity, in order to reduce priority and amount. 
  306. Additionally, weaponkick & hitflash is disabled for all players. 
  307.  
  308. This should free a little more bandwidth than the standard 46% of TheMod, 
  309. compared to standard quake. 
  310.  
  311. Have fun!   
  312. -surgeon   
  313.  
  314. ============================================================================= 
  315.  
  316. Credits:   
  317.  
  318. Main coding, ideas, optimizations & arena maps docra1-5:   
  319. - 'surgeon'   
  320.  
  321. Testing: 'surgeon' & 'siir'   
  322.  
  323. QuakeC & map resources, implemented and customized for TheMod by 'surgeon':   
  324. - David 'crt' Wright (Rocketarena code & sounds V1.2)   
  325. (http://www.planetquake.com/servers/arena/fasrv12.zip)   
  326. - 'Kashua' (kascam V1.8)   
  327. - 'Dr.Banzai' (Voting server patch)   
  328. - 'Nacho' (arena map: rarena3)   
  329. - Brian 'plucky' Ploeckelman (arena map: arenax)   
  330.  
  331. Bugreprots to: christian.michael@groenjord.dk   
  332.  
  333. =============================================================================   
  334.  
  335. Short history:   
  336.  
  337. 22/6 - 99: Version 0.98 
  338. - Direct admin features added for players (previously only observers) 
  339. - Admin status is retained until admin types "noadmin", 
  340.   or players vote to remove admin 
  341. - Anti-lag toggle (effects filter) 
  342. - Random map rotation for ffa modes made independent of "samelevel" cvar
  343. - Status of antilag, deathcomments and powerups toggle is retained
  344.   across levels.
  345. - Weaponkick switchable for every player 
  346. - Hitflash switchable for every player
  347. - PFX toggle modified to turn off light at once 
  348. - During match, observers are unlocked if one player disconnects 
  349.   This makes it possible to replace the player 
  350. - The "i-mode" command now lists status of toggles  
  351. - Fixed some problems with "allowjoin" command. 
  352. - Directed the "camera running" message to observer only 
  353. - Fixed bug with healthpack not respawning in ffa3 mode 
  354. - Fixed bug that could cause server-crash in ffa-modes
  355.  
  356. 10/6 - 99: Version 0.95   
  357. - Seperate cfg files for matchmodes, ffamodes & arenamode 
  358. - Direct admin features for observers 
  359. - Onlinehelp revised 
  360. - Aliases are now only sent when players connect 
  361. - Mode3 in match modes is now a toggle and does not require restart 
  362. - Matches now exit with a level-restart  
  363. - Various small fixes 
  364. - Full documentation written 
  365. - Included short documentation for RocketArena (arena.htm) 
  366. - Restructured the pakfiles 
  367.  
  368. 25/5 - 99: Version 0.9    
  369. - RocketArena mode works correctly! (bugfix)   
  370. - Corpses left at disconnect removed (bugfix)   
  371. - added online help for arenamode   
  372.  
  373. 12/5 - 99: Initial beta release   
  374.  
  375.    
  376.  
  377.    
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.